/*
 * SonarQube
 * Copyright (C) 2009-2021 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.ce.task.projectanalysis.duplication;

import org.sonar.ce.task.projectanalysis.analysis.AnalysisMetadataHolder;

/**
 * A simple holder to know if the cross project duplication should be computed or not.
 *
 * A log will be displayed whether or not the cross project duplication is enabled or not.
 */
public interface CrossProjectDuplicationStatusHolder {

  /**
   * Cross project duplications is enabled when :
   * <ui>
   *   <li>{@link AnalysisMetadataHolder#isCrossProjectDuplicationEnabled()} is true</li>
   *   <li>{@link AnalysisMetadataHolder#getBranch()} ()} is null</li>
   * </ui>
   */
  boolean isEnabled();

}
